<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3//EN">
<HTML><HEAD>
<TITLE>IBM Visualization Data Explorer Programmer&#39;s Reference</TITLE>

<META HTTP-EQUIV="abstract" CONTENT="IBM Visualization Data Explorer
Programmer&#39;s Reference">
<META HTTP-EQUIV="contact" CONTENT="IBM Visualization Data Explorer
(ibmdx@watson.ibm.com)">
<META HTTP-EQUIV="owner" CONTENT="IBM Visualization Data Explorer
(ibmdx@watson.ibm.com)">
<META HTTP-EQUIV="updated" CONTENT="Tue, 16 Sep 1997 ">
<META HTTP-EQUIV="review" CONTENT="Fri, 14 Aug 1998 ">

<META HTTP-EQUIV="keywords" CONTENT="GRAPHICS VISUALIZATION VISUAL PROGRAM DATA
MINING">
<meta http-equiv="content-type" content="text/html;charset=ISO-8859-1">
</HEAD><BODY BGCOLOR="#FFFFFF">

<A NAME="Top_Of_Page"></A>
<H1>IBM Visualization Data Explorer Programmer&#39;s Reference</H1>
<B>&#91; <A HREF="#Bot_Of_Page">Bottom of Page</A> &#124; <A
HREF="progu198.htm">Previous Page</A> &#124; <A HREF="progu200.htm">Next
Page</A> &#124; <A HREF="../proguide.htm#ToC">Table of Contents</A> &#124; <A
HREF="progu097.htm#PToC20">Partial Table of Contents</A> &#124; <A
HREF="progu344.htm#HDRINDEX_START">Index</A> &#93;</B><HR><P>
<H3><A NAME="HDRDXGRAI"
HREF="progu097.htm#PToC_293">DXGetRegularArrayInfo</A></H3>
<A NAME="IDX1790"></A>
<A NAME="IDX1791"></A>
<P><STRONG>Function</STRONG>
<P>
Returns the number of items, the origin, and the delta of a Regular
Array.
<P><STRONG>Syntax</STRONG>
<BR>
<TT><STRONG><BR>
&#35;include &lt;dx/dx.h&gt;<BR>
<P><BR>
RegularArray DXGetRegularArrayInfo(RegularArray a, int *count,<BR>
                                   Pointer origin, Pointer delta)<BR>
</STRONG></TT><BR>
<P><STRONG>Functional Details</STRONG>
<P>
If
<TT><STRONG>
count
</STRONG></TT>
is not
<TT><STRONG>NULL</STRONG></TT>,
this routine returns in
<TT><STRONG>
*count
</STRONG></TT>
the
number of points.  If
<TT><STRONG>
origin
</STRONG></TT>
is not
<TT><STRONG>NULL</STRONG></TT>,
it returns in
<TT><STRONG>
*origin
</STRONG></TT>
the position of the first point.  If
<TT><STRONG>
delta
</STRONG></TT>
is not
<TT><STRONG>NULL</STRONG></TT>,
it returns in
<TT><STRONG>
*delta
</STRONG></TT>
the spacing between the points.  Both
<TT><STRONG>
origin
</STRONG></TT>
and
<TT><STRONG>
delta
</STRONG></TT>
must point to buffers large enough to hold one
item of the type of
<TT><STRONG>a</STRONG></TT>.  The information about
<TT><STRONG>
a
</STRONG></TT>
may be
obtained by calling
<TT><STRONG>DXGetArrayInfo</STRONG></TT>.
<P>
Regular Arrays provide a compact representation for a sequence of
<TT><STRONG>
count
</STRONG></TT>
points beginning at
<TT><STRONG>
origin
</STRONG></TT>
and extending in the direction specified by the
<TT><STRONG>
delta
</STRONG></TT>
vector and spaced
<TT><STRONG>
delta
</STRONG></TT>
apart.  The dimensionality of
<TT><STRONG>
origin
</STRONG></TT>
and
<TT><STRONG>
delta
</STRONG></TT>
may be found through a call to
<TT><STRONG>DXGetArrayInfo</STRONG></TT>.  By
accessing the origin and delta information directly, it may be
possible to process Regular Arrays without expansion.  Array handles
provides a mechanism for accessing individual elements of a Regular
Array without expansion.
<P><STRONG>Return Value</STRONG>
<P>
Returns <TT><STRONG>a</STRONG></TT> or returns <TT><STRONG>NULL</STRONG></TT>
and sets an error code.
<P><STRONG>See Also</STRONG>
<P>
<TT><STRONG>
<A HREF="progu124.htm#HDRDXCAH">DXCreateArrayHandle</A>,
<A HREF="progu157.htm#HDRDXGAI">DXGetArrayInfo</A>,
<A HREF="progu259.htm#HDRDXNRA">DXNewRegularArray</A>
</STRONG></TT>
<P>
<A HREF="progu046.htm#HDRRRAS">"Regular Arrays"</A>.
<P><HR><B>&#91; <A HREF="#Top_Of_Page">Top of Page</A> &#124; <A
HREF="progu198.htm">Previous Page</A> &#124; <A HREF="progu200.htm">Next
Page</A> &#124; <A HREF="../proguide.htm#ToC">Table of Contents</A> &#124; <A
HREF="progu097.htm#PToC20">Partial Table of Contents</A> &#124; <A
HREF="progu344.htm#HDRINDEX_START">Index</A> &#93;</B> <br><b>&#91;<a
href="../allguide.htm">Data Explorer Documentation</a>&nbsp;&#124;&nbsp;<a
href="../qikguide.htm">QuickStart Guide</a>&nbsp;&#124;&nbsp;<a
href="../usrguide.htm">User&#39;s Guide</a>&nbsp;&#124;&nbsp;<a
href="../refguide.htm">User&#39;s Reference</a>&nbsp;&#124;&nbsp;<a
href="../proguide.htm">Programmer&#39;s Reference</a>&nbsp;&#124;&nbsp;<a
href="../insguide.htm">Installation and Configuration
Guide</a>&nbsp;&#93;</b><br><p><b>&#91;<a
href="http://www.research.ibm.com/dx">Data Explorer Home
Page</a>&#93;</b><p><HR ALIGN=LEFT WIDTH=600><b>&#91;<A
HREF="http://www.ibm.com/">IBM Home Page</A>&nbsp;&#124;&nbsp;<A
HREF="http://www.ibm.com/Orders/">Order</A>&nbsp;&#124;&nbsp;<A
HREF="http://www.ibm.com/Search/">Search</A>&nbsp;&#124;&nbsp;<A
HREF="http://www.ibm.com/Assist/">Contact IBM</A>&nbsp;&#124;&nbsp;<A
HREF="http://www.ibm.com/Legal/">Legal</A>&nbsp;&#93;</b><hr><p>
<A NAME="Bot_Of_Page"></A>
</BODY></HTML>
